﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed

#pragma once
#include "IEventArgs.h"
#include "GcmpApplicationInterface.h"

namespace gcmp
{
    /// \brief ApplicationEventType 定义应用程序事件类型。 事件触发时机，做什么事情合适
    enum class ApplicationEventType : int32_t
    {
        PreExecute,   ///< 应用程序执行前。
        Executed,     ///< 应用程序执行。
        PreClose,     ///< 主窗口被关闭前触发此事件。
        Closed        ///< 程序退出，所有事件处理对象被销毁之前触发此事件。
    };

    /// \brief  应用程序事件参数接口。
    ///
    class GCMP_APPLICATION_INTERFACE_EXPORT IApplicationEventArgs : public IEventArgs
    {
        DEFINE_CAST_DERIVED(gcmp::IApplicationEventArgs, gcmp::IEventArgs)

    public:
        /// \brief 获取应用程序事件类型。
        ///
        /// \return 应用程序事件类型。
        virtual ApplicationEventType GetType() const = 0;

        /// \brief 判断应用程序关闭的类型。对应ApplicationEventType::PreClose事件。
        /// 
        /// \return 返回值表示应用程序关闭的类型。返回true表示应用程序是由用户手动关闭；返回false表示应用程序是由程序自动关闭。 
        virtual bool IsApplicationClosedByUser() = 0;
    };
}
